uniqueid2.h File Reference

This file contains API for UNIQUE ID 2 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures
struct	uniqueid2_t
	UNIQUE ID 2 Click context object. More...
struct	uniqueid2_cfg_t
	UNIQUE ID 2 Click configuration object. More...

Macros
#define	UNIQUEID2_REG_DTI   0xE0
	UNIQUE ID 2 register list.
#define	UNIQUEID2_REG_CDA   0xC0
#define	UNIQUEID2_REG_SWP   0xA0
#define	UNIQUEID2_REG_UID   0x00
#define	UNIQUEID2_DTI_DEFAULT   0xB1
	UNIQUE ID 2 DTI register setting.
#define	UNIQUEID2_CDA_C2   0x08
	UNIQUE ID 2 CDA register setting.
#define	UNIQUEID2_CDA_DAL   0x01
#define	UNIQUEID2_SEL_ID_PAGE   0x00
	UNIQUE ID 2 ID page setting.
#define	UNIQUEID2_BLOCK_SIZE   65536
	UNIQUE ID 2 memory block setting.
#define	UNIQUEID2_BLOCK_ADDR_MASK   0xFFFF
#define	UNIQUEID2_SWP_BP_QUARTER   0x00
	UNIQUE ID 2 SWP register setting.
#define	UNIQUEID2_SWP_BP_HALF   0x02
#define	UNIQUEID2_SWP_BP_THREE_QUARTER   0x04
#define	UNIQUEID2_SWP_BP_ALL   0x06
#define	UNIQUEID2_SWP_BP_MASK   0x06
#define	UNIQUEID2_SWP_WPA   0x08
#define	UNIQUEID2_SWP_WPL   0x01
#define	UNIQUEID2_UID_LEN   16
	UNIQUE ID 2 UID setting.
#define	UNIQUEID2_UID_HEADER_ST_CODE   0x20
#define	UNIQUEID2_UID_HEADER_BUS_PROTOCOL   0xE0
#define	UNIQUEID2_UID_HEADER_DENSITY   0x12
#define	UNIQUEID2_WC_WRITE_ENABLE   0x00
	UNIQUE ID 2 write control setting.
#define	UNIQUEID2_WC_WRITE_DISABLE   0x01
#define	UNIQUEID2_PAGE_SIZE   256
	UNIQUE ID 2 memory setting.
#define	UNIQUEID2_ID_PAGE_SIZE   256
#define	UNIQUEID2_MEMORY_SIZE   262144
#define	UNIQUEID2_PAGE_OFFSET_MASK   0xFF
#define	UNIQUEID2_BLOCK_OFFSET   16
#define	UNIQUEID2_BLOCK_MASK   0x03
#define	UNIQUEID2_DEVICE_ADDRESS_MEM   0x50
	UNIQUE ID 2 device address setting.
#define	UNIQUEID2_DEVICE_ADDRESS_REG   0x58
#define	UNIQUEID2_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	uniqueid2_return_value_t { UNIQUEID2_OK = 0 , UNIQUEID2_ERROR = -1 }
	UNIQUE ID 2 Click return value data. More...

Functions
void	uniqueid2_cfg_setup (uniqueid2_cfg_t *cfg)
	UNIQUE ID 2 configuration object setup function.
err_t	uniqueid2_init (uniqueid2_t *ctx, uniqueid2_cfg_t *cfg)
	UNIQUE ID 2 initialization function.
err_t	uniqueid2_default_cfg (uniqueid2_t *ctx)
	UNIQUE ID 2 default configuration function.
err_t	uniqueid2_write_memory (uniqueid2_t *ctx, uint32_t address, uint8_t *data_in, uint16_t len)
	UNIQUE ID 2 write memory function.
err_t	uniqueid2_read_memory (uniqueid2_t *ctx, uint32_t address, uint8_t *data_out, uint32_t len)
	UNIQUE ID 2 read memory function.
err_t	uniqueid2_write_register (uniqueid2_t *ctx, uint8_t reg, uint8_t data_in)
	UNIQUE ID 2 write register function.
err_t	uniqueid2_read_register (uniqueid2_t *ctx, uint8_t reg, uint8_t *data_out)
	UNIQUE ID 2 read register function.
err_t	uniqueid2_read_id_page (uniqueid2_t *ctx, uint8_t offset, uint8_t *data_out, uint16_t len)
	UNIQUE ID 2 read ID page function.
err_t	uniqueid2_read_uid (uniqueid2_t *ctx, uint8_t *uid)
	UNIQUE ID 2 read UID function.
void	uniqueid2_set_wc_pin (uniqueid2_t *ctx, uint8_t state)
	UNIQUE ID 2 set WC pin function.

Detailed Description

This file contains API for UNIQUE ID 2 Click Driver.

Enumeration Type Documentation

uniqueid2_return_value_t

enum uniqueid2_return_value_t

UNIQUE ID 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
UNIQUEID2_OK
UNIQUEID2_ERROR